/**
 * Copyright (c) 2010, iDA MediaFoundry
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * - Redistributions of source code must retain the above copyright notice,
 *   this list of conditions and the following disclaimer.
 *
 * - Redistributions in binary form must reproduce the above copyright notice,
 *   this list of conditions and the following disclaimer in the documentation
 *   and/or other materials provided with the distribution.
 *
 * - Neither the name of iDA MediaFoundry nor the names of its contributors may
 *   be used to endorse or promote products derived from this software without
 *   specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */
package be.idamf.flash.events
{
	import flash.events.IEventDispatcher;
	
	/**
	 *  In situations where one needs to remove all event listeners to avoid 
	 *  memory leaks, it may be possible to replace an IEventDispatcher
	 *  with this implementation, with the benefit of a complete disposal 
	 *  of listener references using one method.  
	 *  
	 *  <p><code>IREventDispatcher</code> is an alternative
	 *  to <code>IEventDispatcher</code>.</p>
	 *
	 *  @see be.idamf.flash.events.REventDispatcher
	 *  
	 *  @author Jan Van Coppenolle
	 */
	public interface IREventDispatcher extends IEventDispatcher
	{
		/**
		 * Adds a weak event listener.
		 * 
		 * <p>This is the only legal method, adding a weak listeners using the
		 * weak flag in an addEventListener call will result in an error being
		 * thrown.</p>
		 * 
		 * @param type Name of the event.
		 * @param listenerHost References the object that has the listener method.
		 * @param listenerMethod The name of the listener method.
		 */
		function addWeakEventListener(type:String, listenerHost:Object, listenerMethod:String, useCapture:Boolean = false, priority:int = 0):void;
		
		/**
		 * Removes all event listeners.
		 * 
		 * <p>By calling this method all weak and non-weak listener references will
		 * be removed from this instance.</p>
		 */
		function removeAllEventListeners():void;
	}
}